-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: activate 'rosetta infuse' feature #17191
Conversation
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
@rix0rrr sounds interesting! Do you have an example of how these infused examples might look? |
@eladb this is actuall the "real examples that get copied around", so they look just like normal examples from the READMEs. Kaizen is working in parallel on a "synthetic usage example" feature which will be coming up soon. |
The examples we copy into docblocks may contain block comments themselves. However, the docblock renderer does not escape the docblock *closing* text, so the doc block gets terminated early and compiling fails: ```java /** * Initialization props for the `NestedStack` construct. * <p> * Example: * <p> * <blockquote><pre>{@code * // Example automatically generated. See aws/jsii#826 * import software.amazon.awscdk.core.App; * import software.amazon.awscdk.core.CfnOutput; * import software.amazon.awscdk.core.NestedStack; * import lib.RestApi; * import lib.Stage; * /** * * This file showcases how to split up a RestApi's Resources and Methods across nested stacks. * * * * The root stack 'RootStack' first defines a RestApi. * * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'. * * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack. * * * * To verify this worked, go to the APIGateway * */ <------------ OOOPS! * public class RootStack extends Stack { * public RootStack(Construct scope) { * super(scope, "integ-restapi-import-RootStack"); * RestApi restApi = RestApi.Builder.cre ``` Revert this until we can address the quoting issue. Reverts #17191
`jsii-rosetta infuse` will modify all the assemblies in-place to add examples to types that don't have examples yet. This feature depends on jsii 1.41, and should not be merged before jsii has been upgraded to that version (either by #17187 or by #17190). Depends-On: #17190 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
`jsii-rosetta infuse` will modify all the assemblies in-place to add examples to types that don't have examples yet. This feature depends on jsii 1.41, and should not be merged before jsii has been upgraded to that version (either by #17187 or by #17190). Depends-On: #17190 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
`jsii-rosetta infuse` will modify all the assemblies in-place to add examples to types that don't have examples yet. This feature depends on jsii 1.41, and should not be merged before jsii has been upgraded to that version (either by #17187 or by #17190). Depends-On: #17190 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
`jsii-rosetta infuse` will modify all the assemblies in-place to add examples to types that don't have examples yet. This feature depends on jsii 1.41, and should not be merged before jsii has been upgraded to that version (either by aws#17187 or by aws#17190). Depends-On: aws#17190 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
The examples we copy into docblocks may contain block comments themselves. However, the docblock renderer does not escape the docblock *closing* text, so the doc block gets terminated early and compiling fails: ```java /** * Initialization props for the `NestedStack` construct. * <p> * Example: * <p> * <blockquote><pre>{@code * // Example automatically generated. See aws/jsii#826 * import software.amazon.awscdk.core.App; * import software.amazon.awscdk.core.CfnOutput; * import software.amazon.awscdk.core.NestedStack; * import lib.RestApi; * import lib.Stage; * /** * * This file showcases how to split up a RestApi's Resources and Methods across nested stacks. * * * * The root stack 'RootStack' first defines a RestApi. * * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'. * * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack. * * * * To verify this worked, go to the APIGateway * */ <------------ OOOPS! * public class RootStack extends Stack { * public RootStack(Construct scope) { * super(scope, "integ-restapi-import-RootStack"); * RestApi restApi = RestApi.Builder.cre ``` Revert this until we can address the quoting issue. Reverts aws#17191
`jsii-rosetta infuse` will modify all the assemblies in-place to add examples to types that don't have examples yet. This feature depends on jsii 1.41, and should not be merged before jsii has been upgraded to that version (either by aws#17187 or by aws#17190). Depends-On: aws#17190 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
jsii-rosetta infuse
will modify all the assemblies in-place toadd examples to types that don't have examples yet.
This feature depends on jsii 1.41, and should not be merged before
jsii has been upgraded to that version (either by #17187 or by #17190).
Depends-On: #17190
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license